Content Generation – Generate Subtopics API
This endpoint will provide you with 10 subtopics generated based on the topic and other parameters you specify.
This endpoint will provide you with 10 subtopics generated based on the topic and other parameters you specify.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
<?php // You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip require('RestClient.php'); $api_url = 'https://api.dataforseo.com/'; // Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard $client = new RestClient($api_url, null, 'login', 'password'); $post_array = array(); // simple way to set a task $post_array[] = array( "topic" => "Steve Jobs", "creativity_index" => 0.9 ); try { // POST /v3/content_generation/generate_sub_topics/live $result = $client->post('/v3/content_generation/generate_sub_topics/live', $post_array); print_r($result); // do something with post result } catch (RestClientException $e) { echo "n"; print "HTTP code: {$e->getHttpCode()}n"; print "Error code: {$e->getCode()}n"; print "Message: {$e->getMessage()}n"; print $e->getTraceAsString(); echo "n"; } $client = null; ?>
The above command returns JSON structured like this:
{ "version": "0.1.20221214", "status_code": 20000, "status_message": "Ok.", "time": "3.1876 sec.", "cost": 0.0001, "tasks_count": 1, "tasks_error": 0, "tasks": [ { "id": "03141150-4426-0543-0000-66e6bdbfc2f8", "status_code": 20000, "status_message": "Ok.", "time": "3.1148 sec.", "cost": 0.0001, "result_count": 1, "path": [ "v3", "content_generation", "generate_sub_topics", "live" ], "data": { "api": "content_generation", "function": "generate_sub_topics", "topic": "Steve Jobs", "creativity_index": 0.9 }, "result": [ { "input_tokens": 19, "output_tokens": 117, "new_tokens": 117, "sub_topics": [ "Steve Jobs and the Power of a Good Story", "The Passion for Apple's Success", "Building a Great Company in an Era of Business Disruption", "How to Build a Great Team at Apple", "What Makes Steve Jobs Different from Other Leaders?", "What is the Importance of a Shared Vision?", "How to Find Your Mission, Values, and Purpose", "What Is It Like Working with Steve Jobs?", "How Does Steve Jobs Inspire You?", "Why Should I Care About Steve Jobs?" ] } ] } ] }
All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name | Type | Description |
---|---|---|
topic |
string | main topic of the content to generate required field main topic for content generation; can contain from 1 to 50 tokens |
creativity_index |
float | creativity of content generation optional field the randomness of the selection of equally probable subsequent tokens; can take values from 0 to 1 default value: 0.8 learn more about this parameter on our help center |
tag |
string | user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response |
As a response of the API server, you will receive JSON-encoded data containing a tasks
array with the information specific to the set tasks.
Description of the fields in the results array:
Field name | Type | Description |
---|---|---|
version |
string | the current version of the API |
status_code |
integer | general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions |
status_message |
string | general informational message you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | total tasks cost, USD |
tasks_count |
integer | the number of tasks in the tasks array |
tasks_error |
integer | the number of tasks in the tasks array returned with an error |
tasks |
array | array of tasks |
id |
string | task identifier unique task identifier in our system in the UUID format |
status_code |
integer | status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here |
status_message |
string | informational message of the task you can find the full list of general informational messages here |
time |
string | execution time, seconds |
cost |
float | cost of the task, USD |
result_count |
integer | number of elements in the result array |
path |
array | URL path |
data |
object | contains the same parameters that you specified in the POST request |
result |
array | array of results |
input_tokens |
integer | number of input tokens |
output_tokens |
integer | number of output tokens |
new_tokens |
integer | number of new tokens |
sub_topics |
array | resulting subtopics |